Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More

babel-import-util

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

babel-import-util

Utility for manipulating imports within babel plugins

100

Supply Chain Security

96

Quality

80

Maintenance

100

Vulnerabilities

100

License


Version published
Weekly downloads
212K
increased by16.94%
Maintainers
1
Weekly downloads
 
Created
Issues
1

babel-import-util

Makes it easier for a babel plugin to emit imported names. Key benefits:

  • the output composes correctly with subsequent babel plugins, because we update Babel's understanding of the bindings
  • redundant imports will be deduplicated automatically
  • written in TypeScript

Usage by example:

If you want to rewrite:

myTarget('hello world');

To:

import { theMethod } from 'my-implementation';
theMethod('hello world');

Your plugin would look like this:

function testTransform(babel) {
  return {
    visitor: {
      Program: {
        enter(path, state) {
          // Always instantiate the ImportUtil instance at the Program scope
          state.importUtil = new ImportUtil(babel.types, path);
        },
      },
      CallExpression(path, state) {
        let callee = path.get('callee');
        if (callee.isIdentifier() && callee.node.name === 'myTarget') {
          callee.replaceWith(state.importUtil.import(callee, 'my-implementation', 'theMethod'));
        }
      },
    },
  };
}

API

import type { NodePath } from '@babel/traverse';
import type * as t from '@babel/types';

class ImportUtil {
  // Import the given value (if needed) and return an Identifier representing
  // it.
  import(
    // the spot at which you will insert the Identifier we return to you
    target: NodePath<t.Node>,

    // the path to the module you're importing from
    moduleSpecifier: string,

    // the name you're importing from that module. Use "default" for the default
    // export. Use "*" for the namespace.
    exportedName: string,

    // Optional hint for helping us pick a name for the imported binding
    nameHint?: string
  ): t.Identifier;

  // If needed, adds a bare import like:
  //    import "your-module";
  importForSideEffect(moduleSpecifier: string): void;

  // Remove an import specifier. If the removed specifier is
  // the last one on the whole import statement, the whole
  // statement is also removed.
  //
  // You can use "default" and "*" as exportedName to handle
  // those special cases.
  removeImport(moduleSpecifier: string, exportedName: string): void;

  // Remove all imports from the given moduleSpecifier. Unlike
  // removeImport(), this can also remove "bare" import statements
  //  that were purely for side effect.
  removeAllImports(moduleSpecifier: string): void;
}

FAQs

Package last updated on 15 Jul 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts